Server Automation Guide - ScxV6Object.List Method

Returns a ScxV6Objects collection representing all objects in the database that share a common class type that are children of this object.

Parameters

Remarks

If Class is an empty string, the List method returns all objects that are children of this object.

The List method generates an error if the object is not a group object.

Example:

The following example written in VB.NET shows the List method retrieving all objects in a group called "Group.Sub-Group":

Dim Svr As ScxV6DbClient.ScxV6Server

Dim Obj As ScxV6DbClient.ScxV6Object

Dim Objs As ScxV6DbClient.ScxV6Objects

Dim Msg As String

' Connect to the server

Svr = New ScxV6DbClient.ScxV6Server

Svr.Connect("MAIN", "", "")

' Find a folder on the system

Obj = Svr.FindObject("Group.Sub-Group")

' List all objects in the folder

Objs = Obj.List("")

' Generate a message summarising the contents

If Objs.Count = 0 Then

Msg = "No objects found in group"

Else

Msg = "Objects:" + vbLf

For Each Obj In Objs

Msg = Msg + Obj.FullName + vbLf

End If

' Display results

MsgBox(Msg)

' Disconnect

Svr.Disconnect()